/**
 * BibSonomy-Rest-Server - The REST-server.
 *
 * Copyright (C) 2006 - 2016 Knowledge & Data Engineering Group,
 *                               University of Kassel, Germany
 *                               http://www.kde.cs.uni-kassel.de/
 *                           Data Mining and Information Retrieval Group,
 *                               University of Würzburg, Germany
 *                               http://www.is.informatik.uni-wuerzburg.de/en/dmir/
 *                           L3S Research Center,
 *                               Leibniz University Hannover, Germany
 *                               http://www.l3s.de/
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.bibsonomy.rest;

import javax.servlet.http.HttpServletRequest;

import org.bibsonomy.model.logic.LogicInterface;
import org.bibsonomy.rest.exceptions.AuthenticationException;

/**
 * interface the handle authentication with the rest server
 *
 * @author dzo
 * @param <T> 
 */
public interface AuthenticationHandler<T> {
	/** the no auth error message */
	public static final String NO_AUTH_ERROR = "Please authenticate yourself.";

	/**
	 * @param authentication
	 * @return <code>true</code> iff the authentication handler can authenticate
	 * the user with the extracted Authentication
	 */
	public boolean canAuthenticateUser(final T authentication);
	
	/**
	 * @param request
	 * @return the extracted authentication object from the request used by the
	 * other methods
	 */
	public T extractAuthentication(final HttpServletRequest request);
	
	/**
	 * authenticats the user based on the extracted authentication
	 * @param authentication
	 * @return the logic for the user
	 * @throws AuthenticationException if the user can not be authenticated
	 */
	public LogicInterface authenticateUser(final T authentication) throws AuthenticationException;
}
